<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: include/sc2api/sc2_agent.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_3d0dfd3160b31ffa512c49330ac8d646.html">sc2api</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">sc2_agent.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* \file sc2_agent.h</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">   \brief The base class for user defined bots.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">The Agent class provides a user with most access into SC2 state and unit manipulation.</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">A user will issue actions to units via the ActionInterface, examine game state with the</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">ObservationInterface, issue blocking commands (such as pathing queries) via the UnitQueryInterface</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">and override library provided events in ClientEvents.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sc2__client_8h.html">sc2api/sc2_client.h</a>&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesc2.html">sc2</a> {</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">class </span>AgentControlImp;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="keyword">class </span>ActionInterface;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">class </span>ActionFeatureLayerInterface;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">class </span>AgentControlInterface;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classsc2_1_1_agent.html">   22</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsc2_1_1_agent.html">Agent</a> : <span class="keyword">public</span> <a class="code" href="classsc2_1_1_client.html">Client</a> {</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <a class="code" href="classsc2_1_1_agent.html">Agent</a>();</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    ~<a class="code" href="classsc2_1_1_agent.html">Agent</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <a class="code" href="classsc2_1_1_action_interface.html">ActionInterface</a>* <a class="code" href="classsc2_1_1_agent.html#ac0725513a2164c76857a7d2615a31264">Actions</a>();</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <a class="code" href="classsc2_1_1_action_feature_layer_interface.html">ActionFeatureLayerInterface</a>* <a class="code" href="classsc2_1_1_agent.html#a0e267c48e4e41e37dc14185113493cc4">ActionsFeatureLayer</a>();</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <a class="code" href="classsc2_1_1_agent_control_interface.html">AgentControlInterface</a>* <a class="code" href="classsc2_1_1_agent.html#ad47b7a7383489567360ce1697d5e1675">AgentControl</a>();</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    AgentControlImp* agent_control_imp_;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;};</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;}</div><div class="ttc" id="classsc2_1_1_agent_html_a0e267c48e4e41e37dc14185113493cc4"><div class="ttname"><a href="classsc2_1_1_agent.html#a0e267c48e4e41e37dc14185113493cc4">sc2::Agent::ActionsFeatureLayer</a></div><div class="ttdeci">ActionFeatureLayerInterface * ActionsFeatureLayer()</div></div>
<div class="ttc" id="classsc2_1_1_client_html"><div class="ttname"><a href="classsc2_1_1_client.html">sc2::Client</a></div><div class="ttdoc">The base class for Agent and ReplayObserver. </div><div class="ttdef"><b>Definition:</b> sc2_client.h:96</div></div>
<div class="ttc" id="namespacesc2_html"><div class="ttname"><a href="namespacesc2.html">sc2</a></div><div class="ttdef"><b>Definition:</b> sc2_action.h:9</div></div>
<div class="ttc" id="classsc2_1_1_agent_html_ac0725513a2164c76857a7d2615a31264"><div class="ttname"><a href="classsc2_1_1_agent.html#ac0725513a2164c76857a7d2615a31264">sc2::Agent::Actions</a></div><div class="ttdeci">ActionInterface * Actions()</div></div>
<div class="ttc" id="sc2__client_8h_html"><div class="ttname"><a href="sc2__client_8h.html">sc2_client.h</a></div><div class="ttdoc">The base class for Agent and ReplayObserver. </div></div>
<div class="ttc" id="classsc2_1_1_agent_html_ad47b7a7383489567360ce1697d5e1675"><div class="ttname"><a href="classsc2_1_1_agent.html#ad47b7a7383489567360ce1697d5e1675">sc2::Agent::AgentControl</a></div><div class="ttdeci">AgentControlInterface * AgentControl()</div></div>
<div class="ttc" id="classsc2_1_1_action_interface_html"><div class="ttname"><a href="classsc2_1_1_action_interface.html">sc2::ActionInterface</a></div><div class="ttdef"><b>Definition:</b> sc2_interfaces.h:292</div></div>
<div class="ttc" id="classsc2_1_1_agent_control_interface_html"><div class="ttname"><a href="classsc2_1_1_agent_control_interface.html">sc2::AgentControlInterface</a></div><div class="ttdef"><b>Definition:</b> sc2_control_interfaces.h:69</div></div>
<div class="ttc" id="classsc2_1_1_agent_html"><div class="ttname"><a href="classsc2_1_1_agent.html">sc2::Agent</a></div><div class="ttdoc">The base class for user defined bots. </div><div class="ttdef"><b>Definition:</b> sc2_agent.h:22</div></div>
<div class="ttc" id="classsc2_1_1_action_feature_layer_interface_html"><div class="ttname"><a href="classsc2_1_1_action_feature_layer_interface.html">sc2::ActionFeatureLayerInterface</a></div><div class="ttdef"><b>Definition:</b> sc2_interfaces.h:351</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
